Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

switch GitHub pages to gh-pages branch #86

Merged
merged 1 commit into from
Sep 28, 2022
Merged

switch GitHub pages to gh-pages branch #86

merged 1 commit into from
Sep 28, 2022

Conversation

willholley
Copy link
Member

@willholley willholley commented Jun 17, 2022 •
edited
Loading

What this PR does / why we need it:

This updates .asf.yaml to use the gh-pages branch as the source for GitHub pages (published to https://apache.github.io/couchdb-helm). This effectively migrates the Helm repository to that branch which defines a new index.yaml referencing the newly created GitHub Release artifacts (see #79).

In addition:

  • Require linear history for the main branch to ensure PRs are up to date prior to merge.
  • Add branch protection to gh-pages to prevent force pushes.

The remaining steps to complete migration are:

  1. Verify the new gh-pages content/Helm repository.
  2. Remove the legacy /docs folder.
  3. Update the PR template to reflect that manual chart packaging is no longer required.
  4. Update CONTRIBUTORS.md to relfect the new process for chart publishing.

@willholley
switch GitHub pages to gh-pages branch
f0c5680 
- Updates .asf.yaml to use the gh-pages branch as the source
for GitHub pages (published to `https://apache.github.io/couchdb-helm`).
- Require linear history for the `main` branch to ensure
   PRs are up to date prior to merge.
- Prevent force push to `gh-pages` branch.
@colearendt
Copy link
Contributor

colearendt commented Jun 18, 2022 •
edited
Loading

Nice!

Just a note for future reference that this migration means:

  • tarballs will no longer be stored in the repository (i.e. the gh-pages branch is basically just for hosting the index.yaml file for the repository)
  • tarballs will be stored in GitHub Releases, and referenced by the index.yaml file using the conventions from the helm community

@willholley willholley requested a review from kocolosk June 22, 2022 11:38
@colearendt
Copy link
Contributor

FWIW it is possible to test this new repo without the migration:

helm repo add couchdb-test https://raw.githubusercontent.com/apache/couchdb-helm/gh-pages/
# "couchdb-test" has been added to your repositories
helm search repo couchdb-test
# NAME                	CHART VERSION	APP VERSION	DESCRIPTION
# couchdb-test/couchdb	3.6.1        	3.2.1      	A database featuring seamless multi-master sync...

@willholley willholley merged commit e4a16d8 into main Sep 28, 2022
@willholley willholley deleted the migrate-gh-pages branch September 28, 2022 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kocolosk kocolosk Awaiting requested review from kocolosk

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@willholley @colearendt